Partially update a cost target.

PATCH 
/cost_target/:id/

Allows partial updates to a cost target by ID, enabling changes to specific fields without requiring a full payload. This endpoint is useful for updating fields such as cost allocation or target parameters.

Request

Path Parameters

id integerrequired

A unique integer value identifying this cost target.

application/json

Body

required

report_id Report id (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

name Name (string)nullable

Possible values: <= 255 characters

target_type Target type (string)nullable

Possible values: <= 255 characters

period Period (string)nullable

Possible values: [MONTHLY, QUARTERLY, ANNUALLY]

status Status (string)nullable

Possible values: [DRAFT, ACTIVE, DELETED]

number_of_periods Number of periods (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

start_date datenullable
end_date datenullable
look_back_period Look back period (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

budget_type Budget type (string)nullable

Possible values: [BOTTOM_UP, TOP_DOWN]

starting_value Starting value (string)nullable

Possible values: [AVERAGE_MONTHLY_LOOK_BACK, PREVIOUS_MONTH]

growth_rate Growth rate (number)nullable
normalization_period Normalization period (boolean)nullable

Responses

200

application/json

Schema

Schema

id ID (integer)
created date-time
modified date-time
report_id Report id (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

name Name (string)nullable

Possible values: <= 255 characters

target_type Target type (string)nullable

Possible values: <= 255 characters

period Period (string)nullable

Possible values: [MONTHLY, QUARTERLY, ANNUALLY]

status Status (string)nullable

Possible values: [DRAFT, ACTIVE, DELETED]

number_of_periods Number of periods (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

start_date datenullable
end_date datenullable
look_back_period Look back period (integer)nullable

Possible values: >= -2147483648 and <= 2147483647

budget_type Budget type (string)nullable

Possible values: [BOTTOM_UP, TOP_DOWN]

starting_value Starting value (string)nullable

Possible values: [AVERAGE_MONTHLY_LOOK_BACK, PREVIOUS_MONTH]

growth_rate Growth rate (number)nullable
normalization_period Normalization period (boolean)nullable
client Client (integer)
created_by Created by (integer)

Example (from schema)

{
  "id": 0,
  "created": "2024-07-29T15:51:28.071Z",
  "modified": "2024-07-29T15:51:28.071Z",
  "report_id": 0,
  "name": "string",
  "target_type": "string",
  "period": "MONTHLY",
  "status": "DRAFT",
  "number_of_periods": 0,
  "start_date": "2024-07-29",
  "end_date": "2024-07-29",
  "look_back_period": 0,
  "budget_type": "BOTTOM_UP",
  "starting_value": "AVERAGE_MONTHLY_LOOK_BACK",
  "growth_rate": 0,
  "normalization_period": true,
  "client": 0,
  "created_by": 0
}

Loading...